balancer: fix SubConn embedding requirement to not recommend a nil panic hazard #7840
+141
−105
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dfawley
added
the
Type: API Change
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #7840 +/- ##
==========================================
+ Coverage 81.86% 81.95% +0.09%
==========================================
Files 374 375 +1
Lines 37978 37993 +15
==========================================
+ Hits 31089 31138 +49
+ Misses 5587 5565 -22
+ Partials 1302 1290 -12
|
arjan-bal
reviewed
Nov 14, 2024
arjan-bal
approved these changes
Nov 14, 2024
Contributor
arjan-bal
left a comment
arjan-bal
left a comment
There was a problem hiding this comment.
vet is requesting adding godoc for the NoOpSubConn methods. One small comment about embedding in test SubConns, otherwise LGTM.
Member
Author
|
I have removed NopSubConn and rewrote things in the SubConn documentation for clarity and to remove some redundancy. Thinking about it, if a user is writing their own LB policy and needs a fake SubConn for testing, then they can safely implement only the methods they know their policy calls and embed a nil SubConn interface. |
easwars
approved these changes
Nov 19, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I deleted the release notes from #7758 and updated them here.
RELEASE NOTES:
balancer.SubConninterface to force implementors to embed a delegate implementation. This requirement is present in the interface documentation, but wasn't enforced earlier.